<?xml version="1.0" encoding="UTF-8" standalone="no"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
  <head>
    <meta http-equiv="Content-Type" content="text/html; charset=UTF-8" />
    <title>push</title>
    <link rel="stylesheet" type="text/css" href="csound.css" />
    <meta name="generator" content="DocBook XSL Stylesheets V1.78.1" />
    <link rel="home" href="index.html" title="The Canonical Csound Reference Manual" />
    <link rel="up" href="DeprecatedTop.html" title="Deprecated Orchestra Opcodes and GEN Routines" />
    <link rel="prev" href="pop_f.html" title="pop_f" />
    <link rel="next" href="push_f.html" title="push_f" />
  </head>
  <body>
    <div class="navheader">
      <table width="100%" summary="Navigation header">
        <tr>
          <th colspan="3" align="center">push</th>
        </tr>
        <tr>
          <td width="20%" align="left"><a accesskey="p" href="pop_f.html">Prev</a> </td>
          <th width="60%" align="center">Deprecated Orchestra Opcodes and GEN Routines</th>
          <td width="20%" align="right"> <a accesskey="n" href="push_f.html">Next</a></td>
        </tr>
      </table>
      <hr />
    </div>
    <div class="refentry">
      <a id="push"></a>
      <div class="titlepage"></div>
      <a id="Indexpush" class="indexterm"></a>
      <div class="refnamediv">
        <h2>
          <span class="refentrytitle">push</span>
        </h2>
        <p>push — 
      Pushes a value into the global stack.  Deprecated.
    </p>
      </div>
      <div class="refsect1">
        <a id="idp220661680"></a>
        <h2>Description</h2>
        <p>
      Pushes a value into the global stack.
    </p>
      </div>
      <div class="refsect1">
        <a id="idp220727504"></a>
        <h2>Syntax</h2>
        <pre class="synopsis"><span class="command"><strong>push</strong></span>  xval1, [xval2, ... , xval31]</pre>
        <pre class="synopsis"><span class="command"><strong>push</strong></span>  ival1, [ival2, ... , ival31]</pre>
      </div>
      <div class="refsect1">
        <a id="idp220730768"></a>
        <h2>Initialization</h2>
        <p>
      <span class="emphasis"><em>ival1 ... ival31 </em></span>  - values to be pushed into the stack.
    </p>
      </div>
      <div class="refsect1">
        <a id="idp220732432"></a>
        <h2>Performance</h2>
        <p>
      <span class="emphasis"><em>xval1 ... xval31 </em></span>  - values to be pushed into the stack.
    </p>
        <p>
      The given values are pushed into the global stack as a bundle. The global stack works in LIFO order: after multiple <a class="link" href="push.html" title="push"><em class="citetitle">push</em></a> calls, <a class="link" href="pop.html" title="pop"><em class="citetitle">pop</em></a> should be used in reverse order.
    </p>
        <p>
      Each <span class="emphasis"><em>push</em></span> or <a class="link" href="pop.html" title="pop"><em class="citetitle">pop</em></a> operation can work on a "bundle" of multiple variables. When using <a class="link" href="pop.html" title="pop"><em class="citetitle">pop</em></a>, the number, type, and order of items must match those used by the corresponding <span class="emphasis"><em>push</em></span>. That is, after a 'push Sfoo, ibar', you must call something like 'Sbar, ifoo pop', and not e.g. two separate 'pop' statements.
    </p>
        <p>
      <span class="emphasis"><em>push</em></span> and <a class="link" href="pop.html" title="pop"><em class="citetitle">pop</em></a> opcodes can take variables of any type (i-, k-, a- and strings). Use of any combination of i, k, a, and S types is allowed. Variables of type 'a' and 'k' are passed at performance time only, while 'i' and 'S' are passed at init time only.
    </p>
        <p>
      push/pop for a, k, i, and S types copy data by value. By contrast, <a class="link" href="push_f.html" title="push_f"><em class="citetitle">push_f</em></a> only pushes a "reference" to the f-signal, and then the corresponding <a class="link" href="pop_f.html" title="pop_f"><em class="citetitle">pop_f</em></a> will copy directly from the original variable to its output signal. For this reason, changing the source f-signal of <a class="link" href="push_f.html" title="push_f"><em class="citetitle">push_f</em></a> before <a class="link" href="pop_f.html" title="pop_f"><em class="citetitle">pop_f</em></a> is called is not recommended, and if the instrument instance owning the variable that was passed by push_f is deactivated before pop_f is called, undefined behavior may occur.
    </p>
        <p>
      Any stack errors (trying to push when there is no more space, or pop from an empty stack, inconsistent number or type of arguments, etc.) are fatal and terminate performance.
    </p>
      </div>
      <div class="refsect1">
        <a id="idp220746992"></a>
        <h2>Examples</h2>
        <p>
      Here is an example of the push opcode. It uses the file <a class="ulink" href="examples/push.csd" target="_top"><em class="citetitle">push.csd</em></a>.
      </p>
        <div class="example">
          <a id="idp220748848"></a>
          <p class="title">
            <strong>Example 1142. Example of the push opcode.</strong>
          </p>
          <div class="example-contents">
            <p>See the sections <a class="link" href="UsingRealTime.html" title="Real-Time Audio"><em class="citetitle">Real-time Audio</em></a> and <a class="link" href="CommandFlags.html" title="Csound command line"><em class="citetitle">Command Line Flags</em></a> for more information on using command line flags.</p>
            <pre class="programlisting">
<span class="csdtag">&lt;CsoundSynthesizer&gt;</span>
<span class="csdtag">&lt;CsOptions&gt;</span>
<span class="comment">; Select audio/midi flags here according to platform</span>
-odac   <span class="comment">;;;realtime audio out</span>
<span class="comment">;-iadc    ;;;uncomment -iadc if realtime audio input is needed too</span>
<span class="comment">; For Non-realtime ouput leave only the line below:</span>
<span class="comment">; -o push.wav -W ;;; for file output any platform</span>
<span class="csdtag">&lt;/CsOptions&gt;</span>
<span class="csdtag">&lt;CsInstruments&gt;</span>
 

<span class="ohdr">sr</span> <span class="op">=</span> 44100 
<span class="ohdr">ksmps</span> <span class="op">=</span> 32 
<span class="ohdr">0dbfs</span>  <span class="op">=</span> 1 
<span class="ohdr">nchnls</span> <span class="op">=</span> 2

<span class="opc">stack</span> 100000 

<span class="oblock">instr</span> 1 

a1	<span class="opc">oscils</span> 0.7, 220, 0 
k1	<span class="opc">line</span> 0, p3, 1 
        <span class="opc">push</span> "blah", 123.45, a1, k1 
        <span class="opc">push</span> <span class="opc">rnd</span>(k1) 

k_rnd	<span class="opc">pop</span> 
S01, i01, a01, k01 <span class="opc">pop</span> 
        <span class="opc">printf_i</span> "S01 <span class="op">=</span> '<span class="op">%</span>s', i01 <span class="op">=</span> <span class="op">%</span>g\n", 1, S01, i01 
ktrig	<span class="opc">metro</span> 5.0 
        <span class="opc">printf</span> "k01 <span class="op">=</span> <span class="op">%</span>.3f, k_rnd <span class="op">=</span> <span class="op">%</span>.3f\n", ktrig, k01, k_rnd 
        <span class="opc">outs</span> a01, a01 

<span class="oblock">endin</span> 
<span class="csdtag">&lt;/CsInstruments&gt;</span>
<span class="csdtag">&lt;CsScore&gt;</span>
 

<span class="stamnt">i</span> 1 0 5 
<span class="stamnt">e</span> 
<span class="csdtag">&lt;/CsScore&gt;</span>
<span class="csdtag">&lt;/CsoundSynthesizer&gt;</span>
</pre>
          </div>
        </div>
        <p><br class="example-break" />
    </p>
      </div>
      <div class="refsect1">
        <a id="idp220753136"></a>
        <h2>See also</h2>
        <p>
      <a class="link" href="stack.html" title="stack"><em class="citetitle">stack</em></a>,
      <a class="link" href="pop.html" title="pop"><em class="citetitle">pop</em></a>,
      <a class="link" href="pop_f.html" title="pop_f"><em class="citetitle">pop_f</em></a> and 
      <a class="link" href="push_f.html" title="push_f"><em class="citetitle">push_f</em></a>.
    </p>
        <p>Using this opcode is somewhat hackish, as you can read here: <a class="ulink" href="http://csound.1045644.n5.nabble.com/passing-a-string-to-a-UDO-td1099284.html" target="_top">http://csound.1045644.n5.nabble.com/passing-a-string-to-a-UDO-td1099284.html</a></p>
      </div>
      <div class="refsect1">
        <a id="idp220758960"></a>
        <h2>Credits</h2>
        <p>By: Istvan Varga.</p>
        <p>2006</p>
        <p>Deprecated as of version 6.04.</p>
      </div>
    </div>
    <div class="navfooter">
      <hr />
      <table width="100%" summary="Navigation footer">
        <tr>
          <td width="40%" align="left"><a accesskey="p" href="pop_f.html">Prev</a> </td>
          <td width="20%" align="center">
            <a accesskey="u" href="DeprecatedTop.html">Up</a>
          </td>
          <td width="40%" align="right"> <a accesskey="n" href="push_f.html">Next</a></td>
        </tr>
        <tr>
          <td width="40%" align="left" valign="top">pop_f </td>
          <td width="20%" align="center">
            <a accesskey="h" href="index.html">Home</a>
          </td>
          <td width="40%" align="right" valign="top"> push_f</td>
        </tr>
      </table>
    </div>
  </body>
</html>
